<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}

h4 {
	margin-top: 25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class="active"><a href="study.html">学术讨论</a></li>
						<li class=""><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class=""><a href="coupon.html">优惠券</a></li>
						<li class=""><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class=""><a href="advert.html">广告</a></li>
						<li class=""><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>学术讨论API</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#getFaculty"><i class="icon-chevron-right"></i>
							获取全部院系专业</a></li>
					<li><a href="#getGroups"><i class="icon-chevron-right"></i>
							获取全部学习小组</a></li>
					<li><a href="#getTopics"><i class="icon-chevron-right"></i>
							获取小组话题</a></li>
					<li><a href="#viewTopic"><i class="icon-chevron-right"></i>
							浏览小组话题</a></li>
					<li><a href="#createGroup"><i class="icon-chevron-right"></i>
							创建学习小组</a></li>	
					<li><a href="#join"><i class="icon-chevron-right"></i>
							加入学习小组</a></li>
					<li><a href="#joinAllow"><i class="icon-chevron-right"></i>
							加入小组审核通过或拒绝</a></li>
					<li><a href="#joinUsers"><i class="icon-chevron-right"></i>
							获取学习小组成员列表</a></li>
					<li><a href="#viewFile"><i class="icon-chevron-right"></i>
							浏览小组共享资料</a></li>
					<li><a href="#uploadFile"><i class="icon-chevron-right"></i>
							上传小组共享资料</a></li>
					
				</ul>

			</div>
			<div class="span9">



				<!-- Typography
        ================================================== -->
				<section id="getFaculty">
					<div class="page-header">
						<h1>获取全部院系专业API</h1>
					</div>

					<h3>1 功能说明</h3>
					<p>此处可以通过api获取曼彻斯特大学的院系专业设置，返回数据为树状结构。学习小组的划分以院系专业为依据，一个专业下可以有多个学习小组。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/study/faculties</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/study/faculties</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
					   (1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>
					
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/study/faculties</code>

					<h4>2.6 返回参数说明</h4>
					<p>此处的返回参数模型同生活信息模块的分类表，基本信息一致，表达的内容含义下表进行说明。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>院系专业（分类）唯一标识。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>院系专业名称</td>
							</tr>
							<tr>
								<td>sortNum</td>
								<td>Integer</td>
								<td>显示序号。该分类显示的先后顺序</td>
							</tr>
							<tr>
								<td>sortPic</td>
								<td>String</td>
								<td>分类图片，这里暂时用不到。。</td>
							</tr>
							<tr>
								<td>sortParent</td>
								<td>Integer</td>
								<td>上级分类标识。如果值为0，则代表是一级分类，上面没有父分类。</td>
							</tr>
							<tr>
								<td>funCode</td>
								<td>Integer</td>
								<td>功能分类标识。这里用不到。</td>
							</tr>
							<tr>
								<td>sortDesc</td>
								<td>String</td>
								<td>分类的详细信息描述。这里用不到。</td>
							</tr>
							<tr>
								<td>children</td>
								<td>List</td>
								<td>子分类列表。如子院系、子专业等。</td>
							</tr>
							<tr style="color:red">
								<td>type</td>
								<td>Integer</td>
								<td>大类区分。此为新增字段，如果为0则为生活信息分类；如果为1则为二手交易分类；2为学校院系专业。此处均为2.</td>
							</tr>
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>

					<pre>
[
    {
        "sortParent": 0, 
        "sortId": 80, 
        "sortCode": ":0:", 
        "sortName": "数学系", 
        "funCode": 0, 
        "infos": [ ], 
        "sortPic": null, 
        "sortNum": 0, 
        "sortDesc": null, 
        "type": 2, 
        "children": [ ]
    }, 
    {
        "sortParent": 0, 
        "sortId": 82, 
        "sortCode": ":0:", 
        "sortName": "生物学院", 
        "funCode": 0, 
        "infos": [ ], 
        "sortPic": null, 
        "sortNum": 1, 
        "sortDesc": null, 
        "type": 2, 
        "children": [ ]
    }, 
    {
        "sortParent": 0, 
        "sortId": 83, 
        "sortCode": ":0:", 
        "sortName": "历史系", 
        "funCode": 0, 
        "infos": [ ], 
        "sortPic": null, 
        "sortNum": 2, 
        "sortDesc": null, 
        "type": 2, 
        "children": [ ]
    }, 
    {
        "sortParent": 0, 
        "sortId": 81, 
        "sortCode": ":0:", 
        "sortName": "计算机学院", 
        "funCode": 0, 
        "infos": [ ], 
        "sortPic": null, 
        "sortNum": 11, 
        "sortDesc": null, 
        "type": 2, 
        "children": [
            {
                "sortParent": 81, 
                "sortId": 84, 
                "sortCode": ":0:81:", 
                "sortName": "信息与计算科学专业", 
                "funCode": 0, 
                "infos": [ ], 
                "sortPic": null, 
                "sortNum": 11, 
                "sortDesc": null, 
                "type": 2, 
                "children": [ ]
            }
        ]
    }
]
</pre>
					<h4>2.9 错误返回示例:暂无。</h4>
				


				</section>


				<!-- Code
        ================================================== -->
				<section id="getGroups">
					<div class="page-header">
						<h1>获取全部学习小组API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>可以通过该处接口获取全部的学习小组列表。支持分页读取，支持根据院系专业筛选小组等等。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/study/groups</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/study/groups</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>否</td>
								<td>Integer</td>
								<td>所属院系专业标识。</td>
							</tr>
							<tr>
								<td>keywords</td>
								<td>否</td>
								<td>String</td>
								<td>提供关键词搜索，关键词仅支持在学习小组名称的搜索。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>否</td>
								<td>Integer</td>
								<td>分页参数，第几页，默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>否</td>
								<td>Integer</td>
								<td>每页信息条数，默认为8条。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/study/groups</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回学习小组的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总的主题数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>学习小组信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>Long</td>
								<td>学习小组唯一标识。</td>
							</tr>
							<tr>
								<td>sortId</td>
								<td>Integer</td>
								<td>所属院系专业唯一标识。</td>
							</tr>
							<tr>
								<td>sortName</td>
								<td>String</td>
								<td>所属院系专业名称。</td>
							</tr>
							<tr>
								<td>lastupdate</td>
								<td>String</td>
								<td>修改时间。</td>
							</tr>
							<tr>
								<td>founderUid</td>
								<td>Long</td>
								<td>小组创始人ID</td>
							</tr>
							<tr>
								<td>founderName</td>
								<td>String</td>
								<td>小组创始人名称。</td>
							</tr>
							<tr>
								<td>joinType</td>
								<td>Integer</td>
								<td>成员加入类型。-1 关闭；0 公开；1 邀请；2 审核</td>
							</tr>
							<tr>
								<td>viewPerm</td>
								<td>Integer</td>
								<td>浏览权限。1 仅成员；0 所有用户</td>
							</tr>
							<tr>
								<td>memberNum</td>
								<td>Integer</td>
								<td>成员数量。</td>
							</tr>
							<tr>
								<td>dateline</td>
								<td>String</td>
								<td>小组创建时间。</td>
							</tr>
							<tr>
								<td>activity</td>
								<td>Integer</td>
								<td>是否激活。</td>
							</tr>
							<tr>
								<td>banner</td>
								<td>String</td>
								<td>小组标志图片链接地址。如：962641ca-3469-4b16-9dfe-f4c0baa0e026.jpg</td>
							</tr>
							<tr>
								<td>groupNum</td>
								<td>Integer</td>
								<td>显示序号。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>String</td>
								<td>学习小组名称。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>String</td>
								<td>学习小组详细信息描述。</td>
							</tr>
							<tr>
								<td>level</td>
								<td>Integer</td>
								<td>学习小组级别。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/study/groups</code>
					<pre>
{
    "result": [
        {
            "groupId": 10, 
            "sortId": 84, 
            "sortName": "信息与计算科学专业", 
            "lastupdate": "2014-01-22 03:49:37", 
            "founderUid": 0, 
            "founderName": "admin", 
            "joinType": 2, 
            "viewPerm": 0, 
            "memberNum": 0, 
            "dateline": "2014-01-20 06:25:19", 
            "activity": 0, 
            "banner": "962641ca-3469-4b16-9dfe-f4c0baa0e026.jpg", 
            "groupNum": 0, 
            "name": "编程爱好者", 
            "level": 0, 
            "description_mc": "哈哈，爱好吗，必须的"
        }
    ], 
    "numPerPage": 8, 
    "pageNum": 1, 
    "totalCount": 1, 
    "totalPage": 1
}
						</pre>



					<h4>2.9 错误返回示例</h4>
					<pre>
{
    "msg": "密码不正确！", 
    "object": null, 
    "code": "2103"
}
					</pre>


				</section>


				<section id="getTopics">
					<div class="page-header">
						<h1>获取小组话题API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取小组信息说明以及该小组下的所有话题列表。</p>
					<p>这里完全同论坛部分的获取全部主题接口，将学习小组看成是论坛版块，具体可参考<a href="forum.html#topics">获取全部论坛主题接口</a>。在调用接口时，需要指明forumType=1(代表学习小组)。如下面的请求示例：</p>
					<br></br>
					<p>请求示例:</p>
					<p><code>http://115.29.250.136:8080/homeInManchester/api/forum/topics?forumId=10&type=0&forumType=1</code></p>
					<p>返回结果:</p>
					<pre>
{
    "result": [
        {
            "sortId": 0, 
            "forumId": 10, 
            "subject": "但是压低", 
            "postDate": 1390530071, 
            "author": "hsmart", 
            "authorId": 21, 
            "userIp": "0:0:0:0:0:0:0:1", 
            "lastPost": 1390530071, 
            "views": 0, 
            "displayOrder": 0, 
            "lastPoster": "hsmart", 
            "lastPostDate": null, 
            "topicId": 18, 
            "replies": 0, 
            "highLight": 0, 
            "colosed": 0, 
            "name": null, 
            "message": "山东省收费", 
            "type": 1, 
            "digest": 0
        }, 
        {
            "sortId": 0, 
            "forumId": 10, 
            "subject": "哈哈哈呵呵呵", 
            "postDate": 1390529084, 
            "author": "hsmart", 
            "authorId": 21, 
            "userIp": "0:0:0:0:0:0:0:1", 
            "lastPost": 1390529084, 
            "views": 0, 
            "displayOrder": 0, 
            "lastPoster": "hsmart", 
            "lastPostDate": null, 
            "topicId": 17, 
            "replies": 0, 
            "highLight": 0, 
            "colosed": 0, 
            "name": null, 
            "message": "山东省发生", 
            "type": 1, 
            "digest": 0
        }
    ], 
    "numPerPage": 8, 
    "pageNum": 1, 
    "totalCount": 2, 
    "totalPage": 1
}					
					</pre>
				</section>

				<!-- 获取会员详细信息
=======================================================
 -->
				<section id="viewTopic">
					<div class="page-header">
						<h1>获取小组话题API</h1>
					</div>
					<h3>功能说明</h3>
					<p>获取学习小组的某个话题包括该话题的回复列表。此处功能完全同论坛部分，可参考：<a href="forum.html#posts">浏览主题帖子</a></p>
					<p>创建小组话题，同样可以参考论坛部分的<a href="forum.html#topic_new">发表论坛主题</a>，需要注意的是，这里需要在提交信息时，增加一个数据项：type=1。（标识为学习小组类型的话题）</p>
					<p>此外，关于学习小组的话题回复、帖子回复也完全同论坛部分，这里均可参考论坛的主题接口设计。<a href="forum.html#reply_topic">回复主题帖子</a>，<a href="forum.html#post_new">回复普通帖子</a></p>
				</section>



				<section id="createGroup">
					<div class="page-header">
						<h1>创建学习小组API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>登录会员均可自行创建学习小组，目前创建的小组个数没有限制。创始人默认为组长，可以通过邀请和加入的方式增加成员。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/study/group</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<p>这里需要提交的数据为一个json字符串，对象原型为Group类,格式信息如下：</p>
					<pre>
{
            "sortId": 84, 
            "joinType": 2, 
            "viewPerm": 0, 
            "banner": "962641ca-3469-4b16-9dfe-f4c0baa0e026.jpg", 
            "name": "编程爱好者", 
            "description_mc": "哈哈，爱好吗，必须的"
}				
					</pre>
					
					<p>下面将针对所有的参数（json串中的key）进行详细介绍：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>sortId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>这里是院系专业的唯一标识。</td>
							</tr>
							<tr>
								<td>joinType</td>
								<td>必填</td>
								<td>Integer</td>
								<td>成员加入方式。0：自由加入（不限制方式）；1：邀请加入（由组长邀请才能加入）；2：审核加入（会员申请加入，组长审核）</td>
							</tr>
							<tr>
								<td>viewPerm</td>
								<td>必填</td>
								<td>Integer</td>
								<td>浏览权限。0： 所有会员可见；1：仅小组成员可见。</td>
							</tr>
							<tr>
								<td>banner</td>
								<td>选填</td>
								<td>String</td>
								<td>为上传图片的名称地址。可以结合图片上传API一起处理，将上传后台的地址赋值给banner。</td>
							</tr>
							
							<tr>
								<td>name</td>
								<td>必填</td>
								<td>String</td>
								<td>学习小组的名称。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>选填</td>
								<td>String</td>
								<td>学习小组内容简介。字符最多500个字符。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回{"value":"true"}。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>未登录用户无权限操作。</td>
							</tr>

						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>
						请求json字符串为：
						<pre>
{
    "sortId": 84, 
    "joinType": 0, 
    "viewPerm": 0, 
    "banner": "962641ca-3469-4b16-9dfe-f4c0baa0e026.jpg", 
    "name": "编程", 
    "description_mc": "哈哈，爱好吗，必须的"
}
						</pre>
					</p>
					<p>
						请求http地址为：
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group</code>
					</p>
					<p>正确返回：</p>
					<pre>
{
    "value": "true"
}
					</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/info</code>
					</p>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}				
				</pre>

				</section>

				<section id="join">
					<div class="page-header">
						<h1>加入学习小组API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>加入学习小组功能。根据学习小组设置的加入方式不同，加入后的权限不同。如果小组设置为审核加入，则成员加入后，还需要组长进行审核才能正式成为该小组的成员。如果小组设置为不限制，则会员加入即可拥有成员权限。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/study/group/user</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>必填</td>
								<td>Long</td>
								<td>学习小组的唯一标识。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/user</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>无</p>
					

					
					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
							
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<p><code>http://115.29.250.136:8080/homeInManchester/api/study/group/user</code></p>
					<p>正确返回：</p>
					<p><code>
{"value":"true"}					
					</code></p>
					<p>请求错误返回：</p>
					<code>
{"msg":"会员未登录！","object":null,"code":"2000"}						
					</code>


					
				</section>


				<section id="joinAllow">
					<div class="page-header">
						<h1>加入小组审核通过或拒绝API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>组长可以对需要审核的小组成员加入申请进行批准或者忽略（拒绝）。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/study/group/user/{allow}</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>必填</td>
								<td>Long</td>
								<td>学习小组的唯一标识。</td>
							</tr>
							<tr>
								<td>userId</td>
								<td>必填</td>
								<td>Long</td>
								<td>申请加入的用户唯一标识。</td>
							</tr>
						</tbody>
					</table>	
					<p>（3）路径参数</p>
					<p>
						路径参数{allow}的值为必须填：
						如果是1 为审核通过；如果是0 为审核拒绝。
					</p>
					
					<h4>2.5 请求示例</h4>
					<p>批准：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/user/1</code>
					</p>
						
					<p>拒绝：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/user/0</code>
					</p>
					
					<h4>2.6 返回参数说明</h4>
					<p>无</p>
					

					
					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
							
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<p><code>http://115.29.250.136:8080/homeInManchester/api/study/group/user/1</code></p>
					<p>正确返回：</p>
					<p><code>
{"value":"true"}					
					</code></p>
					<p>请求错误返回：</p>
					<code>
{"msg":"会员未登录！","object":null,"code":"2000"}						
					</code>


					
				</section>


				<section id="joinUsers">
					<div class="page-header">
						<h1>获取学习小组成员列表API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取某学习小组下的所有申请加入的或者已经正式批准的成员列表。</p>
					

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/study/group/users</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>必填</td>
								<td>Long</td>
								<td>学习小组的唯一标识。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>必填</td>
								<td>int</td>
								<td>成员状态。目前共有两个值：0标识申请；1标识正式成员（通过审核的）</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/users</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>Long</td>
								<td>当前学习小组ID。</td>
							</tr>
							<tr>
								<td>username</td>
								<td>String</td>
								<td>申请人加入的用户名称</td>
							</tr>
							<tr>
								<td>topics</td>
								<td>Long</td>
								<td>该成员发表的主题数。</td>
							</tr>
							<tr>
								<td>replies</td>
								<td>Long</td>
								<td>该成员的回复数。</td>
							</tr>
							<tr>
								<td>lastupdate</td>
								<td>Long</td>
								<td>该成员最后更新时间。</td>
							</tr>
							<tr>
								<td>joindateline</td>
								<td>Long</td>
								<td>申请加入的时间秒数。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>int</td>
								<td>成员状态。0标识申请；1标识已批准。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<p>无</p>

					<h4>2.8 正确返回示例：</h4>
					<p>获取申请加入的成员列表：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/users?groupId=11&status=0</code>
					</p>
					<pre>
[
    {
        "groupId": 11, 
        "username": "hsmart", 
        "userId": 21, 
        "topics": 0, 
        "lastupdate": 0, 
        "joindateline": 1392543210, 
        "replies": 0, 
        "status": 0
    }, 
    {
        "groupId": 11, 
        "username": "hello001", 
        "userId": 38, 
        "topics": 0, 
        "lastupdate": 0, 
        "joindateline": 1392543267, 
        "replies": 0, 
        "status": 0
    }
]
						</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						无。
					</p>
					

				</section>


				<section id="viewFile">
					<div class="page-header">
						<h1>浏览小组共享资料API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>该接口提供显示学习小组内部上传的共享文档等资源，内部成员可以下载和上传。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/study/group/files</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>

					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>必填</td>
								<td>Long</td>
								<td>学习小组ID。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>选填</td>
								<td>Integer</td>
								<td>请求页数（第几页）。默认为第一页。</td>
							</tr>
							<tr>
								<td>numPerPage</td>
								<td>选填</td>
								<td>Integer</td>
								<td>每页信息条数。默认为8条数据。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/files</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总的数据条数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>学习小组共享资源信息列表集合，具体返回参数说明参考下面<a href="#result">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>username</td>
								<td>String</td>
								<td>上传成员名称。</td>
							</tr>
							<tr>
								<td>forumId</td>
								<td>Long</td>
								<td>所属学习小组的唯一标识。这里同groupId，如果没有groupId，forumId将和groupId代表的含义一样，均代表学习小组唯一标识。</td>
							</tr>
							<tr>
								<td>attachmentId</td>
								<td>Long</td>
								<td>上传记录唯一标识。</td>
							</tr>
							<tr>
								<td>attachmentTime</td>
								<td>String</td>
								<td>上传时间。</td>
							</tr>
							<tr>
								<td>fileType</td>
								<td>Integer</td>
								<td>上传类型。</td>
							</tr>
							<tr>
								<td>uid</td>
								<td>Long</td>
								<td>上传成员用户ID。</td>
							</tr>
							<tr>
								<td>fileIcon</td>
								<td>String</td>
								<td>文件图标地址。</td>
							</tr>
							<tr>
								<td>size</td>
								<td>String</td>
								<td>文件大小。</td>
							</tr>
							<tr>
								<td>fileName</td>
								<td>String</td>
								<td>原上传文件名称。</td>
							</tr>
							<tr>
								<td>file</td>
								<td>String</td>
								<td><p>上传后存储在服务器的文件名称，如：27fba6cf-bf09-4978-b302-2f85cad5af93.docx。该处可以在前面追加服务器文件存储的固定路径：</p><p><code>http://115.29.250.136:8080/homeInManchester/resources/fileupload/study/</code></p><p>下载地址即为：http://115.29.250.136:8080/homeInManchester/resources/fileupload/study/27fba6cf-bf09-4978-b302-2f85cad5af93.docx</p></td>
							</tr>
							
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<p>无。</p>

					<h4>2.8 正确返回示例：</h4>
					
					<p>请求地址：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/study/group/files?groupId=11&pageNum=1&numPerPage=10</code>
					</p>
					<pre>
{
    "result": [
        {
            "username": "hsmart", 
            "forumId": 11, 
            "attachmentId": 1, 
            "attachmentTime": "2014-01-26 11:40:45", 
            "fileType": 0, 
            "uid": 21, 
            "fileIcon": null, 
            "size": null, 
            "fileName": "服务器需求 .docx", 
            "file": "27fba6cf-bf09-4978-b302-2f85cad5af93.docx"
        }
    ], 
    "pageNum": 1, 
    "numPerPage": 10, 
    "totalCount": 1, 
    "totalPage": 1
}
						</pre>


					
				</section>


				<section id="uploadFile">
					<div class="page-header">
						<h1>上传共享资料API</h1>
					</div>
					
					<h3>1 功能说明</h3>
					<p>学习小组成员拥有上传文件的权限，目前不限制上传大小，以小文件为主。客户端可以对上传文件的类型进行控制。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p><code>http://[域名]/api/study/group/file</code></p>
					<p>测试环境：</p>
					<p><code>http://115.29.250.136:8080/homeInManchester/api/study/group/file</code></p>
					<h4>2.2  返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a></p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>groupId</td>
								<td>必填</td>
								<td>Long</td>
								<td>学习小组ID。</td>
							</tr>
						</tbody>
					</table>
					
					<h4>2.5 请求示例</h4>
					<p>请求链接：</p>
					<p><code>http://115.29.250.136:8080/homeInManchester/api/study/group/file</code></p>
					
					<p>web请求方式：</p>
					<div class="well">
						<div>
							<input type="file" name="file" id="file" value="">
						</div>
						<div>
						<button type="button" id="saveBtn" class="btn btn-success">上传</button>
						</div>
						
					</div>
					
					<p>ajax方式上传图片代码：</p>
						<pre>
$("#saveBtn").click(function(){
			$.ajaxFileUpload({
				url:'http://115.29.250.136:8080/homeInManchester/api/study/group/file?groupId=11',//用于文件上传的服务器端请求地址
				secureuri:false,//一般设置为false
				fileElementId:'file',//文件上传空间的id属性 
				dataType: 'JSON',//返回值类型 一般设置为json(大写)
				success: function (data, status){
					console.log(data);
				},
				error: function (data, status, e){
					alert(e);
				}
			})
		})			
						</pre>
					
					
					
					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>value</td>
								<td>String</td>
								<td>返回结果的值。如果是形如：xxx.xx的文件名，则上传成功；如果返回null，则为失败。</td>
							</tr>
						</tbody>
					</table>
					
					<h4 >2.7 错误返回码说明</h4>
					<p>公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。 </p>
					<p>私有错误返回码：暂无。</p>
					
					<h4>2.8 正确返回示例：</h4>
						
						<pre>
{"value":"6bc82cb0-ca04-44a9-b535-a73840e9b4ec.docx"}
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}		
					</pre>
					
					
				</section>


			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
